Account Closure Metrics

GET /accounts/closure-request/metrics

Description

Retrieve closure metrics related to user accounts within a specified date range, allowing customization through various parameters.

Query Parameters

Name	Type	Description
from	string	(Optional). Start date for the metrics period. Include in the request query parameters.
to	string	(Optional). End date for the metrics period. Include in the request query parameters.
groupByList	array[string]	(Optional). Group the metrics by specific criteria. Available values: USER_PROFILE_ID, USER_ID, ACCOUNT_UUID, CURRENCY, TENANT_ID, CLOSURE_REASON, REQUEST_STATUS. Include in the request query parameters.
filterByAccountUuid	array[string]	(Optional). Filter metrics by account UUID. Include in the request query parameters.
filterByUserProfileId	array[string]	(Optional). Filter metrics by user profile ID. Include in the request query parameters.
filterByWalletUserId	array[string]	(Optional). Filter metrics by wallet user ID. Include in the request query parameters.
filterByCurrency	array[string]	(Optional). Filter metrics by currency. Include in the request query parameters.
filterByTenantId	array[string]	(Optional). Filter metrics by tenant ID. Include in the request query parameters.
filterByClosureReason	array[string]	(Optional). Filter metrics by closure reason. Include in the request query parameters.
filterByRequestStatus	array[string]	(Optional). Filter metrics by request status. Include in the request query parameters.

Response Code: 200 - OK

Description

Account closure metrics returned successfully.

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

---

Response Code: 400 - Bad Request

Description: Invalid account closure

Example

<response>
  <status>false</status>
  <statusCode>400</statusCode>
  <message>Invalid account id</message>
  <data></data>
  <errors>
    <error>
      <message>Invalid account id</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

curlUrl: "/accounts/closure-request/metrics" curlMethod: GET

Response Code: 404 - Not Found

Description

Account not found.

Example

<response>
  <status>false</status>
  <statusCode>404</statusCode>
  <message>Account id not found</message>
  <data></data>
  <errors>
    <error>
      <message>Account id not found</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

/platform/wallets/accounts/closure-request/metrics

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string